home *** CD-ROM | disk | FTP | other *** search
/ Amiga Tools 2 / Amiga Tools 2.iso / grafik / bildanzeiger / egsflick / egsflick.doc < prev    next >
Text File  |  1995-03-09  |  12KB  |  269 lines
  1.  
  2.  
  3.         EGSFlick - play .FLI/.FLC animations on your EGS graphic board
  4.  
  5.                     By Frank Neumann, September 1994
  6.                         Version 1.2, 13.09.1994
  7.  
  8.                 Original source by Ron Schnell et al.
  9.  
  10. What's it ?
  11. -----------
  12. EGSFlick lets you play all of those nice .FLI/.FLC animations on your (EGS
  13. supporting) graphic board that you've seen so often in Pee-Cee computer
  14. shops demoing some strange VGA board.
  15. As well .FLI (fixed resolution of 320x200 pixels) as .FLC (free resolution)
  16. animation files are recognized and played.
  17. This program is a port of the X11 program 'xflick'. Great parts of the
  18. source have been taken over unmodified. The authors of this program so far
  19. were:
  20.     Ron Schnell (ronnie@sos.com)
  21.     Klaus Ehrenfried (klaus@spock.es.go.dlr.de)
  22.     Michael 'Papa' ;-) Pall (pall@rz.uni-karlsruhe.de)
  23.  
  24. Lots of thanks go to these guys for somehow making EGSFlick possible.
  25.  
  26. The original program was placed in the Public Domain, with the following
  27. conditions:
  28. ----- excerpt from original xflick.txt: -----
  29.         xflick - Ron Schnell, March, 1991
  30.     This code is provided as is, with no warrantees, expressed
  31.         or implied.  I believe this code to be free of encumbrance,
  32.         and offer it to the public domain.  I ask, however, that
  33.     this paragraph and my name be retained in any modified
  34.     versions of the file you may make, and that you notify me
  35.     of any improvements you make to the code.
  36.  
  37.     Ron Schnell (ronnie@sos.com)
  38. ----- end of excerpt -----
  39.  
  40. I think by porting xflick to EGS I have not hurt any of these conditions.
  41. I wanted to tell Ron Schnell about this port, but unfortunately there was
  42. no user 'ronnie' at 'sos.com' - probably he has left their house. Oh well.
  43.  
  44.  
  45. Requirements
  46. ------------
  47. EGSFlick will make no attempt to convert the .FLI/.FLC file into any other
  48. format than what it is supposed for: 8 bit, CLUT-based chunky pixel data.
  49. For that reason, you will need a graphic board that can produce such
  50. displays. Currently I know of the following that can do it for sure:
  51. · Rainbow III
  52. · Piccolo
  53. · Spectrum
  54.  
  55. It should also work on a GVP EGS 110/24, but I haven't been able to test
  56. that. It would also work on other boards like the Picasso II if EGS were
  57. available for them :^).
  58.  
  59. EGSFlick will either open a window on the EGS default screen, or on a
  60. screen whose mode name you provide with the 'EGSFLICK' environment.
  61.  
  62.  
  63.  
  64. Besides all this, you certainly need:
  65. · AmigaDOS/Kickstart/Workbench 2.0 or above
  66. · EGS (version 6 is ok but not required - I wrote this long before V6 or
  67.   any kind of multiple-device EGS was out)
  68. · A graphic board capable of producing the above mentioned display
  69. · FLI files to play. I have included a small one. I once found this
  70.   somewhere on a CD-Rom at my local PC shop, and liked it very much :-)
  71.  
  72.  
  73. Usage
  74. -----
  75. Usage: EGSFlick [-v] [-r<count>] [-d<delay>] [-n] fli_file
  76.  -v Verbose Debugging info
  77.  -r<count>  Repeat count times (0 = loop forever)
  78.  -d<delay>  Delay between frames in 1/70s
  79.  -n         Don't interpret file before display (slower but uses less memory)
  80.  
  81. Anything more to say ? Well, maybe this:
  82. On short anims, you can let EGSFlick unpack all images into memory and play
  83. them from there (provided you have enough RAM free) to gain maximum speed.
  84. With .FLCs or big .FLIs, however, it is recommended to use the -n switch.
  85. This will cause the pictures to be unpacked while the animation is playing,
  86. which saves a LOT of memory, but also slows down the replay speed.
  87.  
  88. To play an animation over and over, use the switch '-r0'.
  89.  
  90. If the environment variable 'EGSFLICK' is unset or set to 'default', 
  91. EGSFlick will only open a window on the default screen. If you want
  92. this, you will first have to start the preferences program EGSScreenmode to
  93. set the default screen's depth to 8 bit unless this is already the case on
  94. your system.
  95. If you have set EGSFLICK to some screen mode name, e.g.
  96.  
  97. setenv EGSFLICK "PICOa:EGS 800x600"
  98.  
  99. or
  100.  
  101. setenv EGSFLICK "LEGSa:EGS 320x240"
  102.  
  103. , EGSFlick will first try to open an 8 bit deep screen with that screen mode
  104. name, and then open a window on that screen. Make sure that you have created
  105. a screen mode with that name - check the list of available screen modes/names
  106. in your system by starting 'EGSScreenmode' and browsing through the 'Display
  107. modes' list.
  108.  
  109. While EGSFlick is loading an animation, it displays the string 'Please wait
  110. while loading the animation' (clever, huh ? ;-) in the center of the window,
  111. and lists the individual frames of the anim in the title bar as they are
  112. parsed and unpacked. Once playing, the title bar shows the name of the
  113. animation.
  114.  
  115.  
  116. Keyboard control
  117. ----------------
  118. It's quite simple. Once the animation is running, you can press:
  119.  
  120. · + to speed up the animation
  121. · - to slow down the animation
  122. · <Space> to pause and single-step
  123. · c to continue after a pause/single step
  124. · q to quit
  125.  
  126. If there are several open windows on the EGS default screen, activating
  127. another window will change the color map to what EGSFlick thinks is the
  128. 'original' colormap. This is a sort of 'private colormap', as seen under
  129. X11. When you re-activate the player window, the colors of the anim file
  130. are restored. To quit the program, use either 'q' or the close gadget at
  131. the upper left corner of the window.
  132.  
  133.  
  134. Notices
  135. -------
  136. EGSFlick is a nice program to demonstrate the speed of a Zorro III
  137. graphic board compared to a Zorro II board. I noticed this effect on a
  138. programmer's meeting in Germany in August '93 (thanks again, Ill). I got
  139. a Piccolo board from the manufacturer to show it to those who were
  140. interested. Well, when we arrived I just plugged the board into my A3k and
  141. started the system. I checked out several programs on the Piccolo board,
  142. and found that my EGSFlick was not playing as fast as I was used to from
  143. my Rainbow III. The next day a collegue asked me, 'So, Franky, you DID set
  144. the jumper on the board to Zorro III mode, didn't you ?' (Hi, Armin ! :-).
  145. Ok, I didn't. I set the jumper, powered up, ran EGSFlick again, and
  146. ZZzooommmm! There it was, the usual speed :-)
  147. Try it yourself if you have a Piccolo and a Zorro III machine: Play an
  148. animation at maximum speed (press the '+' key several times while the anim
  149. is playing) with the jumper once set to 'Zorro II' and then set to
  150. 'Zorro III'. I'm sure you WILL appreciate the difference between
  151. 3 MBytes/sec and 9.4 MBytes/sec 8-).
  152.  
  153. Known bugs
  154. ----------
  155.  
  156. · The 'private colormap' mechanism is just a simple hack. Whenever a running
  157. EGSFlick window receives an EI_iACTIVEWINDOW message, it activates its
  158. current colormap, and on the other hand when receiving an EI_iINACTIVEWINDOW
  159. message, it restores the colormap that it thinks was the original one.
  160. You can easily confuse EGSFlick by running two such processes simultaneously
  161. and quitting the one you started first. This isn't sure to show the problem,
  162. but it has done so sometimes. Don't expect anything like pen sharing. This
  163. program was written to be fast, not well-behaving.
  164.  
  165. · The resolution of the delay is quite coarse. At the fastest rates you can
  166. just choose between '1/50th of a second between two pictures' and 'go as fast
  167. as you can'. Solution would be to go via the timer.device instead of
  168. dos.library/Delay. Currently I'm too lazy/busy to change this :-}
  169.  
  170. · Originally the key to continue an animation was <Return>, not 'c'.
  171. Unfortunately I do not get an EI_iVANILLAKEY message when the <Return> key is
  172. pressed - Ulli believes EI_iRAWKEY should be ok for this. Well, I disagree.
  173. AmigaDOS windows _DO_ tell me about a VANILLAKEY message caused by pressing
  174. the <Return> key - although it is a 'non-printable' character..hint hint Ulli.
  175.  
  176. · A damaged .FLI/.FLC file is not always recognized as such by the unpacker.
  177. You can be lucky and it tells you about problems and exits gracefully, but
  178. you might as well see the big Guru. Sorry, I didn't write that part of the
  179. code, and I won't go into debugging it.
  180.  
  181. · I haven't yet found out how to clearly judge if the default screen is
  182. made up of planar or chunky pixels. For that reason, EGSFlick will try to
  183. run e.g. on a 'NTSC:High Res' screen with 8 bits depth (AGA for instance).
  184. However, this will most definitely crash your machine.
  185.  
  186.  
  187. ToDo
  188. ----
  189.  
  190. · several things, which will probably never be done.. :-}
  191.  
  192.  
  193. History
  194. -------
  195. The first version of this program was hacked together in two days, just
  196. before the CeBIT'93 in Hanover at the end of March. I wanted to get this
  197. done very quickly to have something for a friend who showed the Rainbow III
  198. graphic board there. I think he liked it.
  199. After that, I almost forgot about this program. Now I saw this new upload in
  200. the AmiNet - some other .fli player - and thought I should make EGSFlick
  201. ready for release. There is as of now so few PD/Freeware EGS software out,
  202. maybe this will encourage some people to go ahead and release what they
  203. have written and not yet 'published', too.
  204.  
  205. Version 1.1 (14.11.1993) :
  206.     First released version
  207.  
  208. Version 1.1a (19.11.1993):
  209.     Removed an E_PIXELMAP check from eflick.c - the program did not run on a
  210.     Spectrum board. I still need to learn a lot about EGS and its
  211.     bitmaps/types.
  212.  
  213. Version 1.2 (13.09.1994):
  214.     After a long break, a small addition: Now listens to the environment
  215.     variable 'EGSFLICK' which determines another screen mode than the
  216.     default. A user on a local BBS asked for something like this, and as
  217.     it was a 10 minute change, I put it in. However, do not expect any
  218.     big enhancements to this program in the future - currently, I'm
  219.     totally fallen for Linux/m68k kernel hacking :-)
  220.  
  221. Author
  222. ------
  223.  
  224. I'm a student of computer science at the University of Oldenburg, Germany
  225. (well, at least I pretend to be one ;-). Hum...what else should I write
  226. here ? Oh well - if you like and use this program, I'm definitely interested
  227. in hearing about that! Let's just declare this whole package to be 'EGSware',
  228. ok ? That means: If you like&use EGSFlick and have written some nice
  229. program(s) for EGS, send it to me. Alternatively, I will not reject any
  230. presents like nice POV-Ray pictures or scenes, self-made .FLIs, money,
  231. chocolate, post cards or whatever. Send what you like :-)
  232.  
  233.  
  234. Shameless plug
  235. --------------
  236. POV-Ray addict ? Check out ftp.informatik.uni-oldenburg.de:/pub/pov-ray :-)
  237.  
  238. Contents of this archive
  239. ------------------------
  240.  
  241. This archive should only be distributed in its unmodified form, consisting
  242. of these files:
  243. EGSFlick/EGSFlick           - the player binary
  244. EGSFlick/EGSFlick.doc       - this document
  245. EGSFlick/EGSFlick.doc.info  - no, I won't explain what this is
  246. EGSFlick/warbeat.fli        - a demo .FLI file, 320x200, 16 frames
  247. EGSFlick/eflick.c           - main part, argument parser, all EGS specific
  248.                               stuff
  249. EGSFlick/read.c             - file parser & unpacker
  250. EGSFlick/eflick.h           - header file, structure definitions etc.
  251. EGSFlick/Makefile           - yep, a Makefile.
  252. EGSFlick.info               - You know. Yes, you really do.
  253.  
  254. The program has been compiled under Dice 2.07.56R, but it should also be easy
  255. to build it under SAS. And no, no DMakefile ist included. I love gnu-make.
  256. If you don't have it, get it NOW ! :-)
  257.  
  258.  
  259. Final words
  260. -----------
  261. Quoting Fred Fish: Have fun !
  262.  
  263. Greetings, questions, bug reports and donations should be sent to:
  264. + Frank Neumann, Hauptstr. 107, 26131 Oldenburg   The Amiga still is it. +
  265. +     InterNet: Frank.Neumann@informatik.uni-oldenburg.de IRC:Franky     +
  266. + UUCP:neumann@uniol.uucp InHouse:amigo@faramir Z-Netz:Neumann@uniol.zer +
  267. + "All die Manta-Computer-User - Hauptsache vorne leuchtet 33Mhz auf..." +
  268. +        - Stefan Schulze in fido.ger.amiga, 04.08.1992                  +
  269.